updated documentation of mean_and_std and mean_and_var ... #607
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ins an inconsistency that should be rather addressed now than postponed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
... but there remains an inconsistency that should be rather addressed now than postponed.
I did this pull request to show the changes (and the additional confusion) that would be necessary in my eyes to resolve the inconsistent default value for
correctedinmean_and_var(x)[defaultcorrected=trueconsistent withStatistics.std(x)] andmean_and_var(x,w)[defaultcorrected=falseconsistent withStatsBase.std(x,w)which is however deprecated].Also, I hope that the code update is adequate because I did not figure out how to test the docstring properly [thankful for easy to reproduce advice].
I personally would not accept the pull request, but I would rather stimulate discussion about whether it is the right time to make a breaking release and resolve the deprecated behavior in StatsBase. But this is obviously not my decision to make.